home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / DESKTOP / FLHELP.SPK / !Help
Text File  |  1997-12-09  |  8KB  |  191 lines
  1. -----------------------------------------------------------------------------
  2. !FlHelp v1.2 (C) David Rushall 1996,1997
  3. -----------------------------------------------------------------------------
  4.  
  5. SYNOPSIS
  6.  
  7. !FlHelp is a replacement for the standard interactive
  8. help program, !Help.
  9.  
  10. -----------------------------------------------------------------------------
  11.  
  12. CONDITIONS OF USE
  13.  
  14. !FlHelp is Freeware and is copyright. It can be distributed and used without
  15. charge provided the original distribution remains intact and unaltered.
  16.  
  17. !FlHelp is supplied 'asis' and use of this software is entirely at the user's
  18. own risk.
  19.  
  20. -----------------------------------------------------------------------------
  21.  
  22. INSTRUCTIONS
  23.  
  24. Like !Help, !FlHelp displays help messages from compatible applications, as
  25. you move the pointer about the screen.
  26.  
  27. However, unlike the !Help application the !FlHelp window automatically
  28. pops-up to the front of the screen, out of the way of the pointer, and only
  29. takes up the height necessary to display the message. Help messages appear
  30. after the pointer has been stationary for around 1/4 second and disappear
  31. again after a few more seconds.
  32.  
  33. When started, !FlHelp will begin to display messages.  Click on the icon bar
  34. icon to temporarily suspend messages, and again to restart.
  35.  
  36. Press 'Menu' on the icon bar icon for further options, including:
  37.  
  38.   Anti-aliased font - would you prefer the system font or a smaller
  39.      anti-aliased one to be used?
  40.  
  41.   Floating help - where would you like the help to appear?
  42.  
  43.      -  at the top or bottom of the screen, depending on the current mouse
  44.         position (the default);
  45.  
  46.      -  or, 'floating' help that follows the mouse around the screen.
  47.  
  48.   Pop-up delay - how long will the mouse have to be stationary before !FlHelp
  49.      displays help messages?
  50.      There are five choices, ranging from instant to about 5 seconds.
  51.  
  52.   Pop-up period - how long should the help messages stay on the screen?
  53.      There are five choices, ranging from about 2 to 10 seconds.
  54.  
  55.   Repeat item - would you like !FlHelp to repeat the help for the same item
  56.      more than once. If selected, !FlHelp will not repeat the help for the
  57.      same item, even if you move the mouse. To repeat the help for the item
  58.      you will have to move to another item for help, and then return to the
  59.      first.
  60.  
  61.   ALT-key mode - when selected, help messages will only be displayed while
  62.      you hold the left ALT key.
  63.  
  64.   Save options - save the current settings as default for next time you run
  65.      !FlHelp.
  66.  
  67. You can only run one instance of !FlHelp at a time. If a second instance
  68. attempts to start it will exit immediately and the first instance will resume
  69. giving help if it has been suspended (or suspend giving help if it was
  70. active).
  71.  
  72. !FlHelp gives interactive help on itself.
  73.  
  74. -----------------------------------------------------------------------------
  75.  
  76. TROUBLESHOOTING
  77.  
  78. As of version 1.2, !FlHelp looks for the standard RISC OS message inserts in
  79. the Resources filing system, enabling it to find the correct level of
  80. messages for you machine.
  81.  
  82. Unfortunately, if !FlHelp is unable to locate the messages file it will not
  83. be able to function. As far as I'm aware, the file always has the same path,
  84. but if you get an error message to the effect that !FlHelp could not find
  85. the messages file then please adjust the following line in the !Run file, to
  86. point to the correct location on your setup.
  87.  
  88.   Set FlHelp$HelpMessages Resources:$.Resources.Help.Messages
  89.  
  90. Please let me know if you have any difficulty.
  91.  
  92. -----------------------------------------------------------------------------
  93.  
  94. SPECIAL NOTICE FOR DEVELOPERS
  95.  
  96. I'd like to encourage the use of Acorn's interactive help protocol - it's
  97. disappointing when applications fail to exploit a standard that can make the
  98. user's life much easier. Perhaps one of the reasons that it is not used as
  99. much as it could is the rather basic !Help front-end supplied with RISC OS.
  100. This is why I wrote !FlHelp.
  101.  
  102. If you write shareware, freeware or public-domain software and would like to
  103. exploit interactive help in a more flexible manner, then perhaps you'd like
  104. to use !FlHelp and distribute it along with your application. You may do
  105. this free of charge, provided you honour the following conditions:
  106.  
  107.   o  Your software is shareware (with a registration fee of no more than
  108.      30 UK pounds), freeware or public domain.
  109.  
  110.   o  You include !FlHelp in the top-level of your distribution, not tucked
  111.      away inside your application's directory.
  112.  
  113.   o  The entire !FlHelp application (including this help file) is distributed
  114.      in its entirity, and unchanged.
  115.  
  116.   o  You make it clear, perhaps in a covering README file in the top-level
  117.      of the distribution, that !FlHelp is an independant freeware application
  118.      that is provided for the benefit of your users.
  119.  
  120. If your application includes buttons to launch interactive help, then
  121. perhaps they could execute a command something like the following (on a
  122. single line, I've split it here for readablity). In this way, !FlHelp will be
  123. launched in favour of Acorn's !Help, but the latter will be used by default
  124. if !FlHelp cannot be found.
  125.  
  126.   *If "<FlHelp$Dir>"<>"" Then WimpTask <FlHelp$Dir>.!Run
  127.      Else WimpTask Resources:$.Apps.!Help.!Run
  128.  
  129. A special feature of !FlHelp is that attempting to re-launch the application
  130. merely toggles the state of the already running instance.
  131.  
  132. This has the effect that the first time the users presses your help button,
  133. !FlHelp will launch and begin showing help. Pressing the button again will
  134. attempt to launch a new instance of !FlHelp which will be detected and
  135. terminated. However, the original instance will suspend the help messages.
  136. Pressing the button again has the reverse effect. This gives the user the
  137. choice between clicking the !FlHelp icon bar icon or your help button to
  138. toggle the display of interactive help.
  139.  
  140. !FlHelp uses the standard Acorn help protocol, and so should be a direct
  141. replacement for !Help. Please contact me if you have any difficulty. If you
  142. decide to distribute !FlHelp with your application I'll attempt to give you
  143. preferencial treatment, with any problems or suggestions you may have. 
  144.  
  145. -----------------------------------------------------------------------------
  146.  
  147. HISTORY
  148.  
  149. 1.0 - 28th June 1996
  150.   Initial version: pop-up to top or bottom of screen.
  151.   Anti-aliased option.
  152.   Auto-resume when second copy attempts to load.
  153.  
  154. 1.1 - 20th April 1997
  155.   Floating help option.
  156.   Period help appears on screen configurable.
  157.   Option not to repeat help for same item.
  158.   Saved settings.
  159.   Non-floating help moved to right of screen.
  160.   Auto-resume changed to toggle status when second copy attempts to load.
  161.  
  162. 1.2 - 25th October 1997
  163.   Improved responsiveness.
  164.   Finds latest \T inserts in !Help.
  165.   ALT-key mode: help only displayed when ALT-key is held.
  166.   Messages for standard window tools.
  167.   Configurable delayed help pop-up.
  168.  
  169. 1.21 - 9th December 1997
  170.   Increased wimp_slot to 64K.
  171.  
  172. -----------------------------------------------------------------------------
  173.  
  174. GETTING IN TOUCH
  175.  
  176. If you'd like to contact me, with comments, suggestions or questions, then I
  177. can be found at:
  178.  
  179.     dave@piecafe.demon.co.uk
  180.  
  181. Please visit my WWW home page for the latest news on this and other software
  182. for Acorn and Psion machines.
  183.  
  184.     http://www.piecafe.demon.co.uk/
  185.  
  186. -----------------------------------------------------------------------------
  187.  
  188. David Rushall - November 1997
  189.  
  190. -----------------------------------------------------------------------------
  191.